/*=========================================================================
 Copyright (c) 2008, Nokia Corporation and/or its subsidiary(-ies).
 All rights reserved.

 Redistribution and use in source and binary forms, with or without
 modification, are permitted provided that the following conditions are met:
 
     * Redistributions of source code must retain the above copyright
       notice, this list of conditions and the following disclaimer.
     * Redistributions in binary form must reproduce the above copyright
       notice, this list of conditions and the following disclaimer in the
       documentation and/or other materials provided with the distribution.
     * Neither the name of the Nokia Corporation and/or its subsidiary(-ies)nor the
       names of its contributors may be used to endorse or promote products
       derived from this software without specific prior written permission.

 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY
 EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
 MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
 THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
 OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR 
 TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
=========================================================================================*/

#ifndef _ncvTemplateMatchOp_H_
#define _ncvTemplateMatchOp_H_

#include "ncvImage.h"
#include "ncvMatrix.h"

/**
 * \class CTemplateMatchOp
 * \brief Template matching operation for two CNokiaCVImages.
 * Calculates the position and value of the best match.
 *
 * Quite simple implementation that does not so local averaging.
 * Also applicable for color images.
 * \note Symbian TClass.
 *
 */
class CTemplateMatchOp : public CImageOp
	{
public:
	/**
	 * \brief Constructor for template matching operation
	 * \param aImage CNokiaCVImage to match against
	 * \param aPattern CNokiaCVImage containing the template to match
	 */
	IMPORT_C CTemplateMatchOp( CNokiaCVImage* aImage, CNokiaCVImage* aTemplate);

	/**
	 * \brief Empty implementation of interface
	 * \param aTarget CNokiaCVImage to store the resulting correlation values
	 * \note the function can leave
	 */
	IMPORT_C void DoOperation( CNokiaCVImage* aTarget = NULL );

	/**
	 * \brief Do the actual operation
	 * \param aPoint resulting matching point
	 * \param aCorrMatrix correlation matrix 
	 * \note the function can leave
	 */
	IMPORT_C void DoOperation( TPoint& aPoint, CNokiaCVMatrix* aCorrMatrix = NULL);
private:
	inline TUint32 GetValueL(CPixelAccess* pa, CPixelAccess* aTempl, TPoint aPoint);

	CNokiaCVImage*		iImage;
	CNokiaCVImage*		iTemplate;

	TInt			iX;
	TInt			iY;
	};

#endif
